docs: Add missing annotations for GtkTextTagTable
authorEmmanuele Bassi <ebassi@gnome.org>
Tue, 1 Dec 2020 15:04:09 +0000 (15:04 +0000)
committerEmmanuele Bassi <ebassi@gnome.org>
Tue, 1 Dec 2020 15:51:52 +0000 (15:51 +0000)
gtk/gtktexttagtable.c
gtk/gtktexttagtable.h

index 70980e3d8fa1a2a1c55e1fd4cbd4ccd0ece2abf9..1435e7375c701d4d4cdb75397cc69b1d247bc768 100644 (file)
@@ -126,6 +126,8 @@ gtk_text_tag_table_class_init (GtkTextTagTableClass *klass)
    * @texttagtable: the object which received the signal.
    * @tag: the changed tag.
    * @size_changed: whether the change affects the #GtkTextView layout.
+   *
+   * Emitted every time a tag in the #GtkTextTagTable changes.
    */
   signals[TAG_CHANGED] =
     g_signal_new (I_("tag-changed"),
@@ -146,6 +148,8 @@ gtk_text_tag_table_class_init (GtkTextTagTableClass *klass)
    * GtkTextTagTable::tag-added:
    * @texttagtable: the object which received the signal.
    * @tag: the added tag.
+   *
+   * Emitted every time a new tag is added in the #GtkTextTagTable.
    */
   signals[TAG_ADDED] =
     g_signal_new (I_("tag-added"),
@@ -162,6 +166,11 @@ gtk_text_tag_table_class_init (GtkTextTagTableClass *klass)
    * GtkTextTagTable::tag-removed:
    * @texttagtable: the object which received the signal.
    * @tag: the removed tag.
+   *
+   * Emitted every time a tag is removed from the #GtkTextTagTable.
+   *
+   * The @tag is still valid by the time the signal is emitted, but
+   * it is not associated with a tag table any more.
    */
   signals[TAG_REMOVED] =
     g_signal_new (I_("tag-removed"),  
index 3602f17cf0c7db7c484f009e81a6f2e7e097e6e2..8076c77a687d2240c2cc625cf1eba3c309db04a1 100644 (file)
@@ -37,6 +37,9 @@ G_BEGIN_DECLS
  * GtkTextTagTableForeach:
  * @tag: the #GtkTextTag
  * @data: (closure): data passed to gtk_text_tag_table_foreach()
+ *
+ * A function used with gtk_text_tag_table_foreach(), to iterate over every
+ * #GtkTextTag inside a #GtkTextTagTable.
  */
 typedef void (* GtkTextTagTableForeach) (GtkTextTag *tag, gpointer data);
 
@@ -44,6 +47,12 @@ typedef void (* GtkTextTagTableForeach) (GtkTextTag *tag, gpointer data);
 #define GTK_TEXT_TAG_TABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TEXT_TAG_TABLE, GtkTextTagTable))
 #define GTK_IS_TEXT_TAG_TABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TEXT_TAG_TABLE))
 
+/**
+ * GtkTextTagTable:
+ *
+ * An object holding all the #GtkTextTag instances for a #GtkTextBuffer.
+ */
+
 GDK_AVAILABLE_IN_ALL
 GType          gtk_text_tag_table_get_type (void) G_GNUC_CONST;